How to start CSUSB JupyterHub
==============================

.. note::

    If you have any questions or find errors on this page, please contact the HPC faculty fellow Youngsu Kim at youngsu.kim@csusb.edu.

.. warning:: 

    The purpose of these insturctions is not to provide the most thorough information. Instead, these should be thought of as the minimal set necessary to start your project. To this end, we provide the links to official insturctions.  

How to start a container on CSUSB JupyterHub 
--------------------------------------------

The following steps will guide you through the login process and image selection on CSUSB JupyterHub hosted at https://csusb-jupyter.nrp-nautilus.io/.

1. Open your browser and naviate to https://csusb-jupyter.nrp-nautilus.io/.

   .. image:: images/start-jupyterhub/login.png
     :width: 500
     :alt: Alternative text

#. Click on ``Sign in with CILogon`` to continue. We use the `CILogon <https://www.cilogon.org/>`_ for credentials. CILogon replies on CSUSB's credential system; currently Duo 

#. Select ``California State University San Bernardino``. One way to avoid going through the long list is to type CSUSB. 

   .. image:: images/start-jupyterhub/cilogon.png
     :width: 500
     :alt: Alternative text

   |

   .. image:: images/start-jupyterhub/cilogon2.png
     :width: 500
     :alt: Alternative text

   |

   .. image:: images/start-jupyterhub/cilogon3.png
     :width: 500
     :alt: Alternative text

#. Click on the green ``Log on`` to continue.

#. The usual...

   .. image:: images/start-jupyterhub/duo.png
     :width: 500
     :alt: Alternative text

   .. _Image Selection:

#. There are a number of images to choose from. 

   .. image:: images/start-jupyterhub/image-selection.png
     :width: 500
     :alt: Alternative text

   |

   .. note::  

       As default we use the images created by the `Pacific Research Platform (PRP) <https://pacificresearchplatform.org/>`_ who is also the host of our HPC. Here is a `link <https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html#gpu-enabled-notebooks>`_ to the description of the PRP images. 
       We help prepare custom images, for instance, ``SageMath``. You can find more information about those images, please visit `here <https://gitlab.nrp-nautilus.io/youngsu_kim/csusb-jupyter-stack>`_.  

#. You can start your server by clicking on the ``Start`` button. If you need to adjust resources, see here. 

#. It may take some time to start your server. Once done, you will be directed to the Jupyter Lab. 

   .. image:: images/start-jupyterhub/spawning.png
     :width: 500
     :alt: Alternative text

#. Enjoy!

   .. image:: images/start-jupyterhub/jupyterlabfrontpage.png
     :width: 500
     :alt: Alternative text



How to switch to another image
--------------------------------------------

.. note::
  Follow the steps 1-3 to shut down your server. 

To choose another image or change resources, one need to re-start the server. 

1. Click on the ``File`` tab.

   .. image:: images/start-jupyterhub/filetab.png
     :width: 500
     :alt: Alternative text

#. Select ``Hub Control Panel``.

#. Click on ``Stop My Server``. After a few miniutes you will see the ``Start My Server`` button. 

   .. image:: images/start-jupyterhub/stopmyserver.png
     :width: 500
     :alt: Alternative text

   |

   .. image:: images/start-jupyterhub/startmyserver.png
     :width: 500
     :alt: Alternative text

   .. note:: 

        It is worth trying to refresh your broswer if there is no response after a few minutes.

#. Follow the :ref:`Step <Image Selection>` as above. 


.. How to adjust resources
.. -------------------------


.. 1. Click on the ``Advanced Options``. 

..   ..  .. image:: images/start-jupyterhub/startmyserver.png
..   ..    :width: 500
..   ..    :alt: Alternative text

.. #. Adjust the resources to suit your need. 

..   ..  .. image:: images/start-jupyterhub/startmyserver.png
..   ..    :width: 500
..   ..    :alt: Alternative text

.. note:: 

  Please follow the National Research Platform's resource usage guideline.